refactor: update botstrap to be more beginner-friendly #3417

onerandomusername · 2025-10-21T23:32:45Z

Update botstrap to be much more userfriendly. This silences noisy logs that we don't want to see or care about when downloading new server.

We also provide a success message when the entire system is successful.

I've also implemented some small caching in the botcore client to only make requests when necessary, and to only make one request to get all of the webhooks. While yes, webhooks are free, I left request logging enabled so the user could see what requests were made. I didn't see a good reason to silence those, both for transparency and because they already provide logging.

We also provide an invite link if the bot isn't in the guild already, but it is configured.

I've also added support which sets the app's flags to enable message content intents and member intent if they aren't already enabled.

closes #3414

jb3

Few review comments.

Can we also squash down the history a little bit? I don't think we need 21 commits for the changes here. Obviously keep the constants one separate but I think we can squash down a lot of the other ones.

botstrap.py

onerandomusername · 2025-10-25T21:37:50Z

@jb3 I've compressed the history and addressed your comments in the updated history. Comments should now follow pep8, formatted with ruff, and silenced pyright.

jb3

Thanks for addressing review feedback.

Only a couple of points left now, but also a couple of wider points:

I think the with block we use now to run the script is too long and I think things like the webhook management & emoji management should be moved into their own methods that we then call (the with should be as small as possible really).
The existing webhook if statement is still a bit scary (I thought I'd left a review comment but can't see/find it now!), I'd prefer creating a new method along the lines of find_matching_webhook, something like:

def find_matching_webhook(existing_webhooks, webhook_model, formatted_name, channel_id):
    for hook in existing_webhooks:
        if hook["id"] == str(webhook_model.id):
            return hook["id"]
        if hook["name"] == formatted_name and hook["channel_id"] == str(channel_id):
            return hook["id"]
    return None

It's all just become a little bit too complex to follow under that context manager and I think that some splitting up into smaller more digestible methods is a good idea here.

jb3 · 2025-10-26T21:25:13Z

botstrap.py

+
+    def get_emoji_contents(self, emoji_id: str | int) -> bytes | None:
+        """Fetches the image data for an emoji by ID."""
+        # emojis are located at https://cdn.discordapp.com/emojis/821611231663751168.png?size=4096


I'd use path-params to document this and where that snowflake comes from (even though it's obvious). Also, not sure the size is necessary given we don't then use it for the subsequent request.

Suggested change

# emojis are located at https://cdn.discordapp.com/emojis/821611231663751168.png?size=4096

# Emojis are located at https://cdn.discordapp.com/emojis/{emoji_id}.png

jb3 · 2025-10-26T21:28:03Z

botstrap.py

+        server_channels = self.guild_channels

        for channel in server_channels:


Suggested change

server_channels = self.guild_channels

for channel in server_channels:

for channel in self.guild_channels:

botstrap.py

jb3

Sorry for these comments all being in parts, just keep doing scans and picking up new bits.

Can we also standardise on whether you're using f-strings in this file or using %s interpolation? There is a mix currently (I appreciate it was f-strings before which is not correct, but if you're adding some f-strings and some %s strings we may as well unify).

botstrap.py

- provide completion message - silence httpcore logger - filter out botcore's warning for patching send_typing - use short url for contributing link - only use logging.warning and up for things that need user action - use logging.fatal when exiting due to error - use % for all logging statements

this lowers the amount of requests we make and reduces the chance of ratelimiting

* request all webhooks in a single call rather than per configured webhook * Enable support for multiple identical test bots sharing the same webhook This should prevent the limit of 10 webhooks per channel from being reached without needing to share a specific guild configuration for the PyDis staff test guild

this makes it easier to configure webhooks: we now only need to set their ID and not their channel. Setting the channel ID is only use for botstrap configuration, anyhow.

…atement

jb3 · 2025-10-27T20:23:00Z

botstrap.py

+        config["emojis"] = self.sync_emojis()
+
+        self.write_config_env(config, self.env_file)
+


This should define the dict with all keys instead of adding individually:

e.g.

config = { "categories": self.get_categories(), ... }

jb3 · 2025-10-27T20:24:13Z

botstrap.py

+                if (
+                    # check the existing ID matches the configured one
+                    existing_hook["id"] == str(webhook_model.id)
+                    or (
+                        # check if the name and the channel ID match the configured ones
+                        existing_hook["name"] == formatted_webhook_name
+                        and existing_hook["channel_id"] == str(all_channels[webhook_name])
+                    )
+                ):
+                    webhook_id = existing_hook["id"]
+                    break


I have commented every review this needs changing 🥲.

Split out to a helper method without the complex conditions. Also, comments should always have a capital (and only be present if they actually add something, for simple conditionals they generally don't).

def find_matching_webhook(existing_webhooks, webhook_model, formatted_name, channel_id): for hook in existing_webhooks: if hook["id"] == str(webhook_model.id): return hook["id"] if hook["name"] == formatted_name and hook["channel_id"] == str(channel_id): return hook["id"] return None

jb3 · 2025-10-27T20:25:05Z

botstrap.py

+        response = self.post(
+            f"/guilds/{self.guild_id}/emojis",
+            json=payload,
+            headers={"X-Audit-Log-Reason": f"Creating {new_name} emoji as part of PyDis botstrap"},


Suggested change

headers={"X-Audit-Log-Reason": f"Creating {new_name} emoji as part of PyDis botstrap"},

headers={"X-Audit-Log-Reason": "Creating emoji as part of PyDis botstrap"},

jb3 · 2025-10-27T20:26:02Z

botstrap.py

+        payload = {
+            "name": new_name,
+            "image": f"data:image/png;base64,{base64.b64encode(emoji_data).decode('utf-8')}",
+        }


Cleaner when not done inline:

Suggested change

payload = {

"name": new_name,

"image": f"data:image/png;base64,{base64.b64encode(emoji_data).decode('utf-8')}",

}

image_data = base64.b64encode(emoji_data).decode('utf-8')

payload = {

"name": new_name,

"image": f"data:image/png;base64,{image_data}",

}

jb3 · 2025-10-27T20:27:09Z

botstrap.py

+
+    def get_emoji_contents(self, id_: str | int) -> bytes | None:
+        """Fetches the image data for an emoji by ID."""
+        # emojis are located at https://cdn.discordapp.com/emojis/{emoji_id}.{ext}


Suggested change

# emojis are located at https://cdn.discordapp.com/emojis/{emoji_id}.{ext}

# Emojis are located at https://cdn.discordapp.com/emojis/{emoji_id}.{ext}

jb3 · 2025-10-27T20:31:02Z

botstrap.py

+    with botstrap:
+        botstrap.run()


I'm not sure if this is the way this should be done or whether it'd be cleaner to create a DiscordClient here, pass it into the botstrap initialiser and then avoid having to define the __exit__ method for the BotStrapper class.

e.g.

with DiscordClient(guild_id=GUILD_ID) as discord_client: botstrap = BotStrapper(client=discord_client)

onerandomusername mentioned this pull request Oct 21, 2025

Support upgrading existing test guilds with botstrap #3418

Open

onerandomusername marked this pull request as ready for review October 22, 2025 00:00

jb3 added the hacktoberfest-accepted label Oct 22, 2025

onerandomusername force-pushed the qt/beginner-friendly-botstrap branch from 496b553 to a0b56a6 Compare October 25, 2025 18:55

jb3 requested changes Oct 25, 2025

View reviewed changes

onerandomusername force-pushed the qt/beginner-friendly-botstrap branch 5 times, most recently from f5f2c3c to a61eb26 Compare October 25, 2025 21:33

onerandomusername requested a review from jb3 October 25, 2025 21:37

jb3 requested changes Oct 26, 2025

View reviewed changes

botstrap.py Outdated Show resolved Hide resolved

jb3 requested changes Oct 26, 2025

View reviewed changes

botstrap.py Outdated Show resolved Hide resolved

botstrap.py Outdated Show resolved Hide resolved

onerandomusername added 4 commits October 27, 2025 10:33

style: format with ruff, fix typehints, save magic values as constants

6b3b3ac

upgrade application flags if intents weren't enabled

b787bc1

provide an invite link if the bot isn't in the configured guild

b488508

onerandomusername force-pushed the qt/beginner-friendly-botstrap branch from a61eb26 to 57c92b0 Compare October 27, 2025 14:38

onerandomusername added 5 commits October 27, 2025 10:43

refactor: cache guild info and guild channels

85665ee

this lowers the amount of requests we make and reduces the chance of ratelimiting

fix: only override the webhook ID for configuring webhooks

4e3fab0

this makes it easier to configure webhooks: we now only need to set their ID and not their channel. Setting the channel ID is only use for botstrap configuration, anyhow.

add audit log reason to requests that support it

3d44321

refactor: sync emojis to the test guild

82fa0b1

onerandomusername force-pushed the qt/beginner-friendly-botstrap branch from 57c92b0 to 82fa0b1 Compare October 27, 2025 19:37

refactor: rewrite Botstrap to be a class instead of one big-old if st…

084b45f

…atement

jb3 requested changes Oct 27, 2025

View reviewed changes

	# emojis are located at https://cdn.discordapp.com/emojis/821611231663751168.png?size=4096
	# Emojis are located at https://cdn.discordapp.com/emojis/{emoji_id}.png

		server_channels = self.guild_channels

		for channel in server_channels:

		config["emojis"] = self.sync_emojis()

		self.write_config_env(config, self.env_file)

	headers={"X-Audit-Log-Reason": f"Creating {new_name} emoji as part of PyDis botstrap"},
	headers={"X-Audit-Log-Reason": "Creating emoji as part of PyDis botstrap"},

Uh oh!

Uh oh!

refactor: update botstrap to be more beginner-friendly #3417

Are you sure you want to change the base?

refactor: update botstrap to be more beginner-friendly #3417

Conversation

onerandomusername commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jb3 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

onerandomusername commented Oct 25, 2025

Uh oh!

jb3 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jb3 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

onerandomusername commented Oct 21, 2025 •

edited

Loading